Skip to main content

Contributing

Why the guidelines

First off, thank you for considering contributing to this project.

Following these guidelines helps to communicate that you respect the time of the developers managing and creating this project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. We created these guidelines to ensure that everyone has the same information when working on the project.

  • Please don't use the issue tracker for support questions.
  • Please check whether the FAQ can help with your issue.
  • Please check the closed tickets & pull requests before opening an new one.

Contributor License Agreement​

We have a Contributor License Agreement which can be found at {root}/docs/getting-started/contributing/agreement.md. It is required for Standard Contributions and Major Contributions.

Responsibilities​

  • Ensure cross-platform compatibility for every change that's accepted.
  • Ensure that code meets all requirements
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Ensure each contribution is created on its own branch to ensure we can follow Semantic Versioning
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds